Range
Function
This API is used to get parameter range for POS page.
Request Message
Parameter description
None.
Sample: :
POST /API/AlarmConfig/Pos/Range HTTP/1.1
{
"version": "1.0",
"data": {}
}
Response message
Parameter description
Table 1
| Parameter | Range | Type | Description |
|---|---|---|---|
| pos_max | 4 ~ 32 | int | Maximum number of POSs that can be configured. |
| btn_get_default_data | bool | Get the default parameter button. | |
| pos_info | 4 ~ 32 | array | see Table 2. |
Table 2
| Parameter | Range | Type | Description |
|---|---|---|---|
| id | 0 ~ 32 | int | POS configuration index. |
| pos_enable | bool | Is POS displayed. | |
| pos_name | 0 ~ 32 | string | The name of POS. |
| switch | bool | POS switch. | |
| start_line | 0 ~ 32 | string | Start symbol. |
| line_break | 0 ~ 32 | string | Line breaks. |
| end_line | 0 ~ 32 | string | End symbol. |
| start_line_hex_enable | bool | The start character enables the hexadecimal switch (only enter characters (0~9, a~f, A~F after turning on, and the number of characters must be even or empty, the number of characters must be even or empty)). | |
| line_break_hex_enable | bool | Line breaks enable hexadecimal switch (only characters between 0~9, a~f, A~F, and characters must be even or empty. The number of characters must be even or empty.). | |
| end_line_hex_enable | bool | End symbol enables the hexadecimal switch (only characters between 0~9, a~f, A~F, and the number of characters must be even or empty). | |
| case_sensitive | bool | Whether to be case sensitive switch. | |
| filter_identifer | bool | Whether to filter the switch of the start ending symbol. | |
| enable_xml_parse | bool | Whether to enable XML format parsing switch. | |
| connect_mode | "RS-485","udp_reception","tcp_reception","multicast" | string array | Connection mode. |
| udp_addr | 7 ~ 15 | string | UDP address that allows connection in UDP connection mode. |
| udp_port | 1 ~ 65535 | int | UDP connection port (ports cannot conflict with other POS ports that have been displayed). |
| tcp_addr | 7 ~ 15 | string | TCP address that allows connection in TCP connection mode. |
| tcp_port | 1 ~ 65535 | int | TCP connection port (port cannot conflict with other POS ports that have been displayed). |
| multicast_addr | 7 ~ 15 | string | Multicast address added during multicast connection mode. |
| multicast_port | 1 ~ 65535 | int | Multicast connection port. |
| binding_channel | "None","CH1"..."CHx" The number of channels depends on the maximum number of channels for the current device | string array | None is currently bound to no channel, and the channel bound to each POS cannot be the same. |
| encode | "UTF-8","UTF-16BE","UTF-16LE","UTF-32","UTF-32BE","UTF-32LE","GB2312","GBK","GB18030","BIG5","WINDOWS-1250","WINDOWS-1251","WINDOWS-1252", "WINDOWS-1253","WINDOWS-1254","WINDOWS-1255","WINDOWS-1256","WINDOWS-1257","WINDOWS-1258","ISO-8859-1","ISO-8859-2","ISO-8859-3","ISO-8859-4", "ISO-8859-5","ISO-8859-6","ISO-8859-7","ISO-8859-8","ISO-8859-9","ISO-8859-10","ISO-8859-13","ISO-8859-14","ISO-8859-15","ISO-8859-16","TIS-620","EUC-CN","EUC-TW","EUC-JP", "EUC-KR","KOI8-R","KOI8-U","KOI8-RU" | string array | Supported encoding types. |
| overlay_mode | "page","scroll" | string array | POS display method. |
| font_size | "the_smallest","smaller","small","normal","big","bigger""the_biggest" | string array | Font size. |
| font_color | "#FFFFFF","#FF8000","#0000FF","#FF0000","#FFFF00","#004080","#00FF00","#000000","#8000FF" | string array | Font color. |
| display_time | 5 ~ 3600 | int | Display time. |
| timeout | 5 ~ 3600 | int | Timeout. |
| privacy1 | 0 ~ 32 | string | Sensitive word 1. |
| privacy2 | 0 ~ 32 | string | Sensitive word 2. |
| privacy3 | 0 ~ 32 | string | Sensitive word 2. |
| enable_preview | bool | Whether to display POS information in preview. | |
| alarm_out | "Local->1"…"Local->x" "IP_CH1->1"…"IP_CHx->x" The number of channels depends on the functionality of the device. | string array | Alarm output channel. Array members represent an alarm output channel with a string. Local->1:On, null value: off. |
| record_channel | "CH1"…"CHx" "IP_CH1"…"IP_CHx" "WIFI_CH1"…"WIFI_CHx" | string array | Channel for linkage recording. (Special for NVR). |
| normal_linkage | object | See POS alarm linkage configuration items Table 3. | |
| schedule_list | Json array | see Table 5. | |
| ptz_linkage_disable | bool | Whether to disable ptz linkage page. | |
| ptz_linkage | object | see Table 6. | |
| rule_rect | Object | Rectangle, information JSON is as follows Table 7. |
Table 3
| Parameter | Range | Type | Description |
|---|---|---|---|
| buzzer | bool | Linked buzzer switch. | |
| full_screen | bool | Linkage board end full screen function. | |
| send_email | bool | Linked mail sending switch. | |
| http_listening | bool | Linked PUSH push switch. | |
| voice_prompts | bool | Linked voice broadcast switch. | |
| voice_prompts_index | int array | File index (0~4294967295, 0 is None, that is, no audio file is selected).Each file is named "Index_File Name" (1_i will try). When displayed on the page, you should hide "Index_", such as "1_i will try", and only "i will try". | |
| voice_prompts_select | int array | Play channel, bitwise calculation (bit0 is local, bit1 corresponds to front-end channel 1, bit2 corresponds to channel 2...). | |
| voice_prompts_time | object array | The broadcast time period setting is set. There is no time conflict in the 12 time periods. See for details Table 4. | |
| voice_prompts_speaker_select | int array | Play ip speaker, bitwise (bit0 is ip speaker 1, bit1 corresponds to ip speaker 2). |
Table 4
| Parameter | Range | Type | Description |
|---|---|---|---|
| start_hour | 0~23 | int | Start time h. |
| start_minute | 0~59 | int | Start time m. |
| start_second | 0~59 | int | Start time s. |
| end_hour | 0~23 | int | Start time h. |
| end_minute | 0~59 | int | Start time m. |
| end_second | 0~59 | int | Start time s. |
Table 5
| Parameter | Range | Type | Description |
|---|---|---|---|
| items | "Local->1", "Local->2", "Local->3", "Local->4", "Local->5", "Local->6", "Local->7", "Local->8" | string | Channel information. |
| enable | bool | Is the schedule enabled. | |
| start_time | 0~1439 | int | Start time. |
| end_time | 0~1440 | int | End time. |
| weekday | "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" | string | Days. |
Table 6
| Parameter | Range | Type | Description |
|---|---|---|---|
| ptz_linkage_chn | array | ptz linkage channel. | |
| ptz_linkage_data | array | ptz linkage data. | |
| preset_dwell_time | [min:max] | int | The minimum time of the preset point residence time is 1 (min), and the maximum time is 20 (max). |
| preset_num | [min:max] | int | The minimum number of preset points is 1 (min), maximum of 255 (max). |
| trace_num | [min:max] | int | The minimum number of trajectory cruises is 1 (min) and the maximum is 4 (max). |
| pattern_scan_num | [min:max] | int | The minimum number of scans for patterns is 1 (min) and the maximum is 4 (max). |
| ptz_linkage_name | "Mode_Preset", "Mode_Trace", "Mode_Pattern_Scan" | array | Preset name. |
Table 7
| Parameter | Range | Type | Description |
|---|---|---|---|
| left | 0-704 | int | X coordinate point in the upper left corner. |
| top | 0-576 | int | Y coordinate point in the upper left corner. |
| width | 300-704 | int | The wide range of rectangular areas. |
| height | 150-576 | int | High range of rectangular areas. |
Sample:
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": "success",
"data": {
"pos_max": 32,
"btn_get_default_data": true,
"pos_info": {
"type": "array",
"size": 32,
"items": [
{
"id": {
"type": "int32",
"mode": "r",
"min": 1,
"max": 32
},
"pos_enable": {
"type": "bool"
},
"pos_name": {
"type": "string",
"min_len": 1,
"max_len": 32
},
"switch": {
"type": "bool"
},
"start_line": {
"type": "string",
"min_len": 0,
"max_len": 32
},
"line_break": {
"type": "string",
"min_len": 0,
"max_len": 32
},
"end_line": {
"type": "string",
"min_len": 0,
"max_len": 32
},
"start_line_hex_enable": {
"type": "bool"
},
"line_break_hex_enable": {
"type": "bool"
},
"end_line_hex_enable": {
"type": "bool"
},
"case_sensitive": {
"type": "bool"
},
"filter_identifer": {
"type": "bool"
},
"enable_xml_parse": {
"type": "bool"
},
"connect_mode": {
"type": "string",
"items": [
"udp_reception",
"tcp_reception",
"multicast"
]
},
"udp_addr": {
"type": "string",
"min_len": 7,
"max_len": 15
},
"udp_port": {
"type": "int32",
"min": 1,
"max": 65535
},
"tcp_addr": {
"type": "string",
"min_len": 7,
"max_len": 15
},
"tcp_port": {
"type": "int32",
"min": 1,
"max": 65535
},
"multicast_addr": {
"type": "string",
"min_len": 7,
"max_len": 15
},
"multicast_port": {
"type": "int32",
"min": 1,
"max": 65535
},
"binding_channel": {
"description": "None is not bind chn",
"type": "string",
"items": [
"None",
"CH1",
"CH2",
"CH3",
"CH4",
"CH5",
"CH6",
"CH7",
"CH8",
"CH9",
"CH10",
"CH11",
"CH12",
"CH13",
"CH14",
"CH15",
"CH16",
"CH17",
"CH18",
"CH19",
"CH20",
"CH21",
"CH22",
"CH23",
"CH24",
"CH25",
"CH26",
"CH27",
"CH28",
"CH29",
"CH30",
"CH31",
"CH32"
]
},
"encode": {
"type": "string",
"items": [
"UTF-8",
"UTF-16BE",
"UTF-16LE",
"UTF-32",
"UTF-32BE",
"UTF-32LE",
"GB2312",
"GBK",
"GB18030",
"BIG5",
"WINDOWS-1250",
"WINDOWS-1251",
"WINDOWS-1252",
"WINDOWS-1253",
"WINDOWS-1254",
"WINDOWS-1255",
"WINDOWS-1256",
"WINDOWS-1257",
"WINDOWS-1258",
"ISO-8859-1",
"ISO-8859-2",
"ISO-8859-3",
"ISO-8859-4",
"ISO-8859-5",
"ISO-8859-6",
"ISO-8859-7",
"ISO-8859-8",
"ISO-8859-9",
"ISO-8859-10",
"ISO-8859-13",
"ISO-8859-14",
"ISO-8859-15",
"ISO-8859-16",
"TIS-620",
"EUC-CN",
"EUC-TW",
"EUC-JP",
"EUC-KR",
"KOI8-R",
"KOI8-U",
"KOI8-RU"
]
},
"overlay_mode": {
"type": "string",
"items": [
"page",
"scroll"
]
},
"font_size": {
"type": "string",
"items": [
"the_smallest",
"smaller",
"small",
"normal",
"big",
"bigger",
"the_biggest"
]
},
"font_color": {
"type": "string",
"items": [
"#FFFFFF",
"#FF8000",
"#0000FF",
"#FF0000",
"#FFFF00",
"#004080",
"#00FF00",
"#000000",
"#8000FF"
]
},
"display_time": {
"type": "int32",
"min": 5,
"max": 3600
},
"timeout": {
"type": "int32",
"min": 5,
"max": 3600
},
"privacy1": {
"type": "string",
"min_len": 0,
"max_len": 32
},
"privacy2": {
"type": "string",
"min_len": 0,
"max_len": 32
},
"privacy3": {
"type": "string",
"min_len": 0,
"max_len": 32
},
"enable_preview": {
"type": "bool"
},
"record_channel": {
"type": "array",
"min_size": 0,
"max_size": 32,
"items": {
"type": "string",
"items": [
"CH1 (Camera)",
"CH3 (光学通道)",
"CH4 (热成像通道)",
"CH5 (Camera4)",
"CH11 (wz-8241)",
"CH12 (wz-cloud-ipc)",
"CH16 (wz-8241)",
"CH18 (wz-8241)"
]
}
},
"alarm_out": {
"type": "array",
"min_size": 0,
"max_size": 65,
"items": {
"type": "string",
"items": [
"Local->1",
"CH1(172.16.10.42)->1",
"CH3(172.16.11.159)->1",
"CH5(172.20.56.26)->1"
]
}
},
"rule_rect": {
"type": "object",
"items": {
"left": {
"type": "int32",
"min": 0,
"max": 704
},
"top": {
"type": "int32",
"min": 0,
"max": 576
},
"width": {
"type": "int32",
"min": 300,
"max": 704
},
"height": {
"type": "int32",
"min": 150,
"max": 576
}
}
},
"normal_linkage": {
"type": "object",
"items": {
"buzzer": {
"type": "bool"
},
"full_screen": {
"type": "bool"
},
"send_email": {
"type": "bool"
},
"voice_prompts": {
"type": "bool"
},
"voice_prompts_index": {
"type": "array",
"min_size": 0,
"max_size": 12,
"items": {
"type": "int32",
"min": 0,
"max": 65535
}
},
"voice_prompts_select": {
"type": "array",
"min_size": 0,
"max_size": 12,
"items": {
"type": "uint32",
"min": 0,
"max": 4294967295
}
},
"http_listening": {
"type": "bool"
},
"voice_prompts_time": {
"type": "array",
"min_size": 0,
"max_size": 12,
"items": [
{
"start_hour": {
"type": "int32",
"min": 0,
"max": 23
},
"start_minute": {
"type": "int32",
"min": 0,
"max": 59
},
"start_second": {
"type": "int32",
"min": 0,
"max": 59
},
"end_hour": {
"type": "int32",
"min": 0,
"max": 23
},
"end_minute": {
"type": "int32",
"min": 0,
"max": 59
},
"end_second": {
"type": "int32",
"min": 0,
"max": 59
}
}
]
},
"voice_prompts_speaker_select": {
"type": "array",
"min_size": 0,
"max_size": 12,
"items": {
"type": "uint32",
"min": 0,
"max": 4294967295
}
}
}
},
"schedule_list": {
"type": "array",
"min_size": 0,
"max_size": 8,
"items": [
{
"enable": {
"type": "bool"
},
"weekday": {
"type": "array",
"min_size": 1,
"max_size": 7,
"items": {
"type": "string",
"items": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
}
},
"start_time": {
"type": "int32",
"min": 0,
"max": 1439
},
"end_time": {
"type": "int32",
"min": 0,
"max": 1440
}
}
]
},
"ptz_linkage": {
"type": "object",
"items": {
"CH1": {
"type": "object",
"items": {
"ptz_linkage_chn": {
"type": "array",
"min_size": 0,
"max_size": 1,
"items": {
"type": "string",
"items": []
}
},
"ptz_linkage_name": {
"type": "array",
"min_size": 0,
"max_size": 3,
"items": {
"type": "string",
"items": [
"Mode_Preset",
"Mode_Trace",
"Mode_Pattern_Scan"
]
}
},
"preset_dwell_time": {
"type": "int32",
"min": 1,
"max": 20,
"default_value": 5
},
"preset_num": {
"type": "int32",
"items": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
82,
83,
84,
85,
86,
87,
88,
89,
90,
91,
92,
93,
94,
95,
96,
97,
98,
99,
100,
101,
102,
103,
104,
105,
106,
107,
108,
109,
110,
111,
112,
113,
114,
115,
116,
117,
118,
119,
120,
121,
122,
123,
124,
125,
126,
127,
128,
129,
130,
131,
132,
133,
134,
135,
136,
137,
138,
139,
140,
141,
142,
143,
144,
145,
146,
147,
148,
149,
150,
151,
152,
153,
154,
155,
156,
157,
158,
159,
160,
161,
162,
163,
164,
165,
166,
167,
168,
169,
170,
171,
172,
173,
174,
175,
176,
177,
178,
179,
180,
181,
182,
183,
184,
185,
186,
187,
188,
189,
190,
191,
192,
193,
194,
195,
196,
197,
198,
199,
200,
201,
202,
203,
204,
205,
206,
207,
208,
209,
210,
211,
212,
213,
214,
215,
216,
217,
218,
219,
220,
221,
222,
223,
224,
225,
226,
227,
228,
229,
230,
231,
232,
233,
234,
235,
236,
237,
238,
239,
240,
241,
242,
243,
244,
245,
246,
247,
248,
249,
250,
251,
252,
253,
254,
255
]
},
"trace_num": {
"type": "int32",
"items": [
1,
2,
3,
4
]
},
"pattern_scan_num": {
"type": "int32",
"items": [
1,
2,
3,
4
]
}
}
}
}
},
"ptz_linkage_disable": true
}
]
}
}
}
Error code
See Response Messages Body and Common error_code for more information.